ModelingRelationship

Relationship definition used in the models when joining across tables columns.

API Section: Objects

Type: Object

Properties

Name

Description

Required

Type

Format

isBiDirectional

Boolean indicating if the join is bi-directional

 -

boolean

columns

The model's system ID

 -

ModelingRelationshipColumnPair [ ]

foreignTableUniqueName

The foreign table's unique name

 -

string

isManyToMany

Boolean indicating if the join is Many-to-Many

 -

boolean

relationshipId

The relationship's system ID

 -

string

uuid

type

The join type (inner, right, left, full outer, or cross join)

 -

JoinType

primaryTableUniqueName

The primary table's unique name

 -

string